home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
doors_2
/
usrbg20.zip
/
USRBIOG.DOC
< prev
next >
Wrap
Text File
|
1992-06-21
|
25KB
|
580 lines
User Biographies v2.0
USRBIOG Door Documentation
Copyright 1992 Ernie Johnson
All Rights Reserved
What is USRBIOG (User Biographies)?
------------------------------------------------------------------
User Biographies (USRBIOG for short) is a BBS "door" program that
allows users on a BBS to write short "biographies" about themselves.
In doing this, other users can read through the biographies and find
other people with similar interests to chat with, leave messages to,
or just to find out what other people are interested in.
USRBIOG's database system can be completely customizable by you, the
sysop to ask questions that you (or your users) want to see in your
database. This makes USRBIOG more customizable for the type of BBS
you run, ie; 'adult', alias, business, etc. USRBIOG can pretty much
be termed as on online "database" program.
What about version 1.0?
------------------------------------------------------------------
The initial release of USERBIOG occured over a year ago, as the
first door program I had ever written. Since then I have had
several requests for customized versions of USERBIOG to support
different field names. I finally decided to take the time and write
a new version that allowed sysops to set this up for themselves.
The only problem is an incompatibility between version 2.0 and 1.0 -
if you had been running version 1.0 prior to this version, the
database would be lost as there is no easy way to convert the old
database to the new database style used - especially since a lot of
people will have different databases with different field names in
it. Registered users of USRBIOG 2.0 may continue to use version 1.0
as long as they wish due to this incompatibility.
Limited Warranty and Software License Agreement
----------------------------------------------------------------------
The USRBIOG.EXE program is no way guaranteed to work as advertised,
although careful testing and design has been used on this program.
IN NO EVENT WILL THE AUTHOR OF THIS PROGRAM BE LIABLE TO YOU FOR ANY
DAMAGES (INCLUDING LOST PROFITS, LOST SAVINGS, OR OTHER INCIDENTAL
OR CONSEQUENTIAL DAMAGES EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES) OR FOR ANY CLAIM BY ANY OTHER PARTY.
This program is provided to you for use provided that you agree to
and abide by the terms listed in this licensing agreement. You
assume responsibility for selection of this program for your
purposes, and for the installation, use and results from use of this
program. This program is licensed to you for use as follows:
1. All copies of this program must include the copyright notice.
2. You may transfer the program(s) and license to another party
if the other party agrees to accept the terms and conditions
of this agreement, and all copies of the program are passed
to this party and any remaining copies in your possession are
destroyed.
3. The SHAREWARE version of this program is provided to your for
an evaluation period not to exceed 30 days.
4. You may not reverse engineer, decompile, or dissemble the
software. You may not modify the software in any way.
5. All files originally in this archive must be redistributed.
For ZIP archives, the original archive should be used due to
the fact it contains an "authenticity verification" code.
Shareware Software & USRBIOG
------------------------------------------------------------------
Please note that the USRBIOG program is "Shareware" software.
You are granted a software license to use this software for a trial
time period not to exceed thirty (30) days before such a time where
registration of this program is required, or you are to discontinue
use of USRBIOG.
When registering USRBIOG, please use the order form below, or print
the ORDER.FRM file and complete it. It makes it easier for us to
process the order, and keep proper records on our registered users.
Registration of USRBIOG is very affordable, and we offer two
different registration options:
1) Full Registration...... For $25.00, you will be mailed the
current version of USRBIOG, your registration "KEY" information,
and you will also receive ALL future versions of USRBIOG FREE of
charge. These will be mailed directly to you.
2) Minimal Registration... For $15.00 you will recieve your
registration "KEY" information only. You will not be mailed any
future versions of USRBIOG, but all versions will be free to you,
the exception is that you will be responsible to download updates
from our support BBS.
Order form for USRBIOG
------------------------------------------------------------------
User Biographies v2.0 - Order Form
NAME: ____________________________________________________
BBS: ____________________________________________________
ADDRESS: ____________________________________________________
____________________________________________________
CITY: ________________________
STATE/PROV: __________________ ZIP/POSTAL CODE: ________________
PHONE: ____________________________________________________
WHERE DID YOU RECEIVE USRBIOG? _________________________________
________________________________________________________________
COMMENTS: ____________________________________________________
________________________________________________________________
Item Price Total
----------------------------------------------------------------
USRBIOG v2.0 Full Registration................. $25.00 _______
All upgrades of USRBIOG will be mailed to
you at no charge.
USRBIOG v2.0 Minimal Registration.............. $15.00 _______
You will be responsible for obtaining ALL
USRBIOG upgrades as they become available.
* See documentation for more Total Amount
detailed information! Enclosed _______
Specify disk format [ ] 5.25, 360K or [ ] 3.5, 720K
Mail checks/money orders/inquiries to:
Ernie Johnson or phone (519) 357-1941 voice, or
P.O. Box 607 (519) 357-1943 BBS
Wingham Ontario for more information.
N0G 2W0 -- Canada
System Requirements
------------------------------------------------------------------
USRBIOG should work on just about any hardware/software configuation
found today. It has been tested on a variety of 286 and 386
computers running PCBoard 14.5a. USRBIOG has also been tested in
local mode using GENERIC.SYS file as outlined later in the
documentation.
USRBIOG requires approximately 256K of RAM free when it runs, and
for multi-node BBS systems, you should have DOS's SHARE.EXE command
loaded for file full sharing support.
Required Files
------------------------------------------------------------------
Most files in the distribution archive are required for USRBIOG to
function. Here is an outline of the files included, their purpose,
and if they are required or not. If any of these files are missing
from the distribution archive, you should call our support BBS and
download an archive that has not been tampered with.
USRBIOG.EXE - USRBIOG executable program - Required
USRBIOG.DAT - USRBIOG database configuration - Required
USERBIOG.KEY - Registration "KEY" information - Required
MENU. - ASCII USRBIOG menu screen - Required
MENUG. - ANSII USRBIOG menu screen - Required
HELP. - User on-line "Help" - Required
USRBIOG.DOC - Sysop Documentation - Optional
GENERIC.SYS - Sample GENERIC.SYS file - Optional
ORDER.FRM - Order form for USRBIOG - Optional
CONVERT.EXE - Database conversion program - Optional
CONVERT.DOC - CONVERT.EXE program documentation - Optional
Created at run-time:
-------------------
USRBIOG.DB - USRBIOG database file - Required
USRBIOG.PX - USRBIOG database index file - Optional
Note that if you delete the USRBIOG.PX file, or it becomes
corrupted, it will be recreated automatically - this file improves
search speed when looking for a particular users name.
Using USRBIOG
------------------------------------------------------------------
For most experienced sysops, using USRBIOG will be fairly
straightforward, both in setup and actual program useage.
For more information on using USRBIOG and what the different menu
options do, refer to the "HELP" file included with this archive.
The "HELP" file is displayed if the user requests "HELP" while in
the door on your BBS.
As a note, USRBIOG supports full file sharing and should never
report a sharing conflict. It (USRBIOG) only allows one person in
the door at a single time just to be sure. If someone is using the
door, and another trys it on another node, the second person will be
informed it is currently in use and to try again later.
If your BBS crashes and a user has been in USRBIOG at the time, you
will need to delete the DORLOCK.DAT file that will be located in the
USRBIOG directory.
USRBIOG's only known "bug" is a problem that causes it to fail at
resetting previous system colors when using DOS. To solve this
problem, simply use the DOS TYPE command to view an ANSI file - for
example: TYPE MENUG <ENTER> - this will reset your screen colors.
For most people, the above won't be much of a problem, but the
solution is simple until the problem can be solved.
Editing User Records
------------------------------------------------------------------
I'm sure that some of your users wouldn't be too happy if you were
to change or 'censor' some of their entries into the database,
however, with some users it becomes a necessity.
Of course, they can always change the record back to the way it was
before it was changed.
At the time of this writing, there are two ways of doing this:
1) the easiest - would be to simply logon as the user who's record
you want to change, make the change and logoff the BBS, or keep
the GENERIC.SYS file in the USRBIOG directory, then run USRBIOG
by typing: USRBIOG GENERIC.SYS <ENTER>, then entering the name of
the person who's record you wish to edit.
2) use a program that lets you read and write "PARADOX" compatible
files. USRBIOG uses Paradox database and index (DB and PX) files
for the database so any Paradox compatible database program, or
Paradox itself will let you make the necessary changes.
At a later date, an editor for local mode (DOS) will be available to
registered users of USRBIOG. Please refer to the section labelled
"The Future of USRBIOG" for more inforation.
Setting up USRBIOG on your PCBoard BBS
------------------------------------------------------------------
If you have had previous experience setting up door programs on your
PCBoard BBS, USRBIOG should be no more difficult than the others you
have set up.
Here is an example batch file as used on EPIC BBS (our support BBS).
Most information should work as displayed with the exception of
drive and path names.
J:
CD\DOORS\USRBIOG
USRBIOG C:\PCB\PCBOARD.SYS
C:
CD\PCB
BOARD
To break down the above:
Line 1: Change to drive where USRBIOG is located on
Line 2: Change to directory where USRBIOG is located in. In this
case, in the \DOORS\USRBIOG directory
Line 3: Run USRBIOG and tell USRBIOG to use the PCBOARD.SYS file
that is located in the C:\PCB directory
Line 4: Change back to the BBS drive
Line 5: Change back to the BBS directory
Line 6: Re-Load the BBS software
You will most likely need to change drive and path names around. A
sample batch file named USRBIOG. has been provided in the archive
for easy modification.
Once you have completed the batch file, run PCBSETUP and edit the
DOORS.LST file for your system. Add an entry that looks similar to
below:
Filename Password Sec Login USERS.SYS DOOR.SYS Path to Batch
-------- -------- --- ----- --------- -------- -----------------
1) USRBIOG 0 N N N C:\DOORS\MAILDOR\
Note this is a sample as seen in the regular PCBoard 14.5 program.
PCBoard 14.5a has a field that allows you to "shell" to the door
instead of exiting PCBoard and reloading PCBoard when the door is
finished. Experienced users may want to experiment with this
option, but USRBIOG is a fair sized program, and will not likely run
when it has been shelled due to memory restrictions.
You will also want to modify your door menu files (most likely named
DOORS and/or DOORSG) to add the USRBIOG entry to it so your users
know which door to open.
Next, you should load PCBoard, and log in locally and run the door
so you can be certain it creates its database files and does not
report any errors.
Other BBS types supported
------------------------------------------------------------------
I own and operate a PCBoard 14.5a BBS system, and can obviously give
you the details on setting up for PCBoard. Unfortunately, I don't
have very much experience on other types of BBS systems.
Below are the different BBS types that are directly supported by
USRBIOG and examples of how to set them up. If you call for
technical assistance, please be aware of the fact I know next to
nothing about the BBS's listed below:
GAP (DOOR.SYS)
Example: USRBIOG C:\GAP\DOOR.SYS
Wildcat! (CALLINFO.BBS)
Example: USRBIOG C:\WC\CALLINFO.BBS
RBBS (DORINFOx.DEF)
Example: USRBIOG C:\RBBS\DORINFO1.DEF
WWIV (CHAIN.TXT)
Example: USRBIOG C:\WWIV\CHAIN.TXT
If you have problems with getting any of the above to work, you
might find it easier to find a door conversion program that converts
to/from your BBS type to either PCBOARD.SYS or DOOR.SYS. USRBIOG
has been tested using both PCBOARD.SYS and DOOR.SYS files. Of
course, you can also use the GENERIC.SYS file (see below) if all
else fails.
GENERIC.SYS - Maximum Compatibility for BBS's
------------------------------------------------------------------
For maximum compatibility, USRBIOG will also read a file called
GENERIC.SYS. This file can be created by the sysop desiring to run
the door and allow USRBIOG to operate. This should allow USRBIOG to
run on just about any BBS that can make use of door programs.
The GENERIC.SYS file is a standard ASCII file and contains 3 lines,
each followed by a carriage return, line feed. The format is:
line 1 - The BBS operator's name.
line 2 - The COM port in use.
line 3 - Time allowed in door.
When USRBIOG reads a GENERIC.SYS, it will ask the user for his/her
first and last names before opening the door. After the user inputs
their name, the door will continue to load and run. Below is an
example GENERIC.SYS file with a sysop name of 'John Doe', using Com
port 1, and allowing 30 minutes in the door.
John Doe
COM1:
30
Each line is followed by a C/R, L/F and the com port follows the
same format as the standard DOOR.SYS. COM0: = Local Mode (same as
DOOR.SYS).
To use the GENERIC.SYS file, simply follow the format used with the
other BBS's, but replace the BBS file with GENERIC.SYS:
ie: USRBIOG GENERIC.SYS
Non-Standard modem ports and interrupts
------------------------------------------------------------------
If you have your modems on a non-standard port address and/or
interrupt setting you can still make use of USRBIOG. A second
command line option to USRBIOG is all that is needed, specifying the
correct information.
For those of you running on non-standard ports and interrupts, I
will assume you know what port and interrupt you are running on.
To properly use USRBIOG, run the program with a second command line
argument that follows the syntax: PORT:AAAA:X
Where AAAA is the port address, and X is the interrupt of where your
modem is located.
For example:
USRBIOG C:\PCB\PCBOARD.SYS PORT:03E8:5
Obtains the PCBoard.sys file in the C:\PCB directory, and uses the
modem at port address 03E8 (hex) and on interrupt 5.
Sysop Keys
------------------------------------------------------------------
The USRBIOG door has a variety of features available to the sysop
while a user is online and using the door. The commands that are
available to the sysop include:
F5 Shell to DOS - be sure to type
"EXIT" to return to USRBIOG
F8 Return user to system - the user will
be given a message stating the sysop
requested a return to the BBS
F9 Toggle display on/off
F10 Chat mode (use the ESCAPE key to exit)
* F3 Toggle printer on/off
* F4 Toggle pagebell on/off
* F7 Toggle caller alarm on/off
ALT-H Toggle between different status lines,
the help screen, and COM port status
* ALT-N Toggle sysop on next
* ALT-X Toggle exit to dos after call
The function keys marked with an "*" will only be of use to systems
using PCBOARD.SYS. The rest are functional with any system.
Customizing USRBIOG's database
------------------------------------------------------------------
The main feature of USRBIOG v2.0 allows you, the sysop, to customize
the database fields of the program.
A file called USRBIOG.DAT is REQUIRED for operation, and the sample
file (which should be adequate for most sysops) is outlined as
follows:
25 City
25 State
25 Country
3 Age
60 Favorite BBS & Number
60 Favorite Movie
60 Favorite TV Show
60 Favorite Music
60 Favorite Foods
60 Favorite Sports
60 Hobbies
60 Other information
60 Summary
The USRBIOG.DAT file is a plain ASCII text file you can create with
a text editor, or the DOS COPY CON: command.
The number listed is the field "length" this number can not exceed
80 characters. The information after the number is the database
field name AND message the user will see when filling out a
biography or viewing a biography. The description/field name CAN
NOT exceed 25 characters in length! USRBIOG also "shortens" the
fields when a user is entering data so they do not scroll to the
next line of the screen. For example, if you set the "Other
Information" field to 80 characters, the user will only be allowed
to type 63 characters (80 less the size of "Other Information").
Please note that you should NOT change database information
(USRBIOG.DAT) when you already have USRBIOG running with a database.
If you do this, USRBIOG will fail giving you error messages.
If you change the USRBIOG.DAT file you MUST DELETE the old database
files and let USRBIOG recreate them from the start again! These files
are USRBIOG.DB and USRBIOG.PX. If you do not wish to delete the
database files and have to start over again, refer to the CONVERT
utility program included with USRBIOG.
** NOTE **
For database search reasons, field 1 is hard coded into the program
as being "Name on BBS" with a length of 30 characters. You can not
change the first field under any circumstances, and that is also why
there is no "name" listed in the sample USRBIOG.DAT file.
Locking out "Malicious" users
------------------------------------------------------------------
I doubt I'm the only unlucky sysop to have the occasional user call
the BBS thinking that things should be done there way, and as a
result of these types of users, I have started incorporating a "Bad
User" routine into my doors. When the door is started, the program
checks for a BADUSER.DAT file, and if this file exists, a list of
names in this file is checked for a match with the name of the user
currently trying to access the door.
If a match is found, the user is informed that he/she is locked out
of the door, and is then returned to the BBS without allowing them
to proceed into the door any further.
To activate the "Bad User" checking, simply create an ASCII text
file with the name of BADUSER.DAT in the USRBIOG program directory
and add the names of your "bad" users to it.
You may use any text editor that produces ASCII text files, or the
DOS COPY:CON command.
For example:
Suppose "JOHN DOE" couldn't enter his biography without cursing
every couple of words, and after leaving him messages to stop or get
locked out of the door he still continued, you could:
COPY CON:BADUSER.DAT
JOHN DOE
^Z
The ^Z is obtained by pressing the "F6" key. Be sure to press ENTER
after each line. Now, if JOHN DOE goes to enter his User Biography
again, the door will tell him he is locked out, and then return him
to the BBS.
To add more than one person to the list, simply press ENTER at the
end of the first persons name, then type the second, press ENTER,
third, etc., until you are finished. Using this file is also a
great way to keep generic accounts out of the door (such as "GUEST
USER").
Product Support
------------------------------------------------------------------
To obtain support for the USRBIOG door program:
Write to: Phone (voice): Phone (bbs):
--------------------------------------------------------------
Ernie Johnson (519) 357-1941 (519) 357-1943 2400 v.42
P.O. Box 607 7pm to 10pm EST (519) 357-2952 38.4 HST D/S
Wingham, Ontario (evenings) 24 hours, 7 days/week
N0G 2W0 -- Canada
OR:
---
On CompuServe, leave a message to Ernest W Johnson [70751,2567]
On City2City netmail services, leave a message to Ernie Johnson in
the Shareware conference.
Note that leaving a message on our support BBS is the fastest way to
obtain support. I check the BBS every day, and phone messages
sometimes don't get checked for a week at a time.
The Future of USRBIOG
------------------------------------------------------------------
Already on the list of things to add in future versions of the
USRBIOG program are:
1) Sysop's database editor - to edit USRBIOG entries without having
to login to the BBS.
2) "Censored" word list checking - allows you to set up a list of
names/words you do not wish to be entered in any field in the
database. If censored words are found, the user is notified and
if not changed, the words will be blanked out with asterisks
(*'s).
3) An optional field that will be updated with the date a record is
added or modified - users can then use the search option to list
all records added or modified since a specific date.
4) Any other great ideas from users of USRBIOG!
End of User Biographies (USRBIOG) Documentation
------------------------------------------------------------------